ref_name-description.md: fix format for PRs #30907
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docs for `github.ref_name` claim that for PRs, the format is `refs/pull/<pr_number>/merge`; however I have just tested this and found that the actual format is `<pr_number>/merge`. This makes sense, since it's more consistent with `github.ref_name` being the short form of `github.ref` in other cases. So fix the docs to represent the actual reality that it returns the short format for PRs too.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
github-actions
bot
added
the
triage
2 tasks
|
@aspiers Thanks so much for opening a PR! I'll get this triaged for review ✨ |
nguyenalex836
added
content
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why:
The current docs for
github.ref_namedo not represent the reality of how it behaves. Instead, they claim that for PRs, the format isrefs/pull/<pr_number>/merge. This claim comes from PR #29712 which was submitted to address issue #15319.However when referring to
github.refandgithub.ref_name, #15319 states:I have just tested this and found that the actual format is indeed
<pr_number>/merge, not the longer version. (This makes sense, since it's more consistent withgithub.ref_namebeing the short form ofgithub.refin other cases.)What's being changed (if available, include any code snippets, screenshots, or gifs):
This PR fixes the docs to represent the actual reality that
github.ref_namealways returns the short format, even for PRs.Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
datadirectory.For content changes, I have completed the self-review checklist.